Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

chore: log the version when starting orchestrator and relayer #630

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Nov 30, 2023

Overview

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • New Features
    • The app now logs build information upon initialization for both the orchestrator and the relayer components, enhancing transparency on the current version in use.

@rach-id rach-id added orchestrator orchestrator related relayer relayer related chore labels Nov 30, 2023
@rach-id rach-id self-assigned this Nov 30, 2023
@rach-id rach-id requested a review from evan-forbes as a code owner November 30, 2023 10:57
Copy link
Contributor

coderabbitai bot commented Nov 30, 2023

Walkthrough

The recent updates to the codebase involve enhancing the initialization process of both the orchestrator and relayer components by incorporating build information logging. This is achieved by importing a new version package and invoking its GetBuildInfo() function, which gathers and logs build details to assist in tracking the version and build state of the applications upon startup.

Changes

File Path Change Summary
cmd/.../orchestrator/cmd.go Imported version package and added build info logging on initialization.
cmd/.../relayer/cmd.go Imported version package and added build info logging on initialization.

🐇✨
To log a version, so clear and bright,
A rabbit hopped through code, with light.
With each GetBuildInfo() call,
The build's tale was told to all. 🌟

(\__/) ||
(•ㅅ•) ||
/   づ

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 071cba2 and 4f8078f.
Files selected for processing (2)
  • cmd/blobstream/orchestrator/cmd.go (2 hunks)
  • cmd/blobstream/relayer/cmd.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • cmd/blobstream/orchestrator/cmd.go
Additional comments: 2
cmd/blobstream/relayer/cmd.go (2)
  • 8-8: The import of github.com/celestiaorg/orchestrator-relayer/cmd/blobstream/version is correctly placed and follows Go conventions for organizing imports.

  • 124-125: The addition of logging the build information using version.GetBuildInfo() is correctly implemented and will provide useful information for debugging and monitoring purposes.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (071cba2) 0.00% compared to head (4f8078f) 25.91%.

Additional details and impacted files
@@            Coverage Diff            @@
##           main     #630       +/-   ##
=========================================
+ Coverage      0   25.91%   +25.91%     
=========================================
  Files         0       29       +29     
  Lines         0     3044     +3044     
=========================================
+ Hits          0      789      +789     
- Misses        0     2160     +2160     
- Partials      0       95       +95     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rach-id rach-id merged commit 2496504 into celestiaorg:main Nov 30, 2023
18 of 19 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
chore orchestrator orchestrator related relayer relayer related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants